A problem that indicates a syntactically correct, yet semantically illegal request. The Server can not process this request until the client resolves the semantic errors described in the violations section.

Conversation

interface Conversation

A user's interaction with AXP, often for a single topic.

ConversationId

typealias ConversationId = String

DialogId

typealias DialogId = String

EngagementId

typealias EngagementId = String

EngagementNotFound

data object EngagementNotFound : AxpSdkError

Error for the case where an engagement is not found.

FieldChangedListener

fun interface FieldChangedListener<T>

Listener interface used for Java applications that can't observe a Kotlin Flow directly.

Forbidden

data object Forbidden : AxpSdkError

Error for the 403 response code - the user is not authorized to access the resource.

IntegrationId

typealias IntegrationId = String

InternalServerError

data object InternalServerError : AxpSdkError

Error for the 500 response code - the server encountered an internal problem and could not process the request.

InvalidConfigParameterException

class InvalidConfigParameterException(val parameterName: String, val parameterValue: String, val extra: String? = null) : ConfigParameterException

Exception thrown for an SDK config parameter that is invalid.

JsonParseError

data class JsonParseError(val message: String) : AxpSdkError

Error for the case where the JSON response from AXP could not be parsed successfully.

JWT

typealias JWT = String

JwtProvider

fun interface JwtProvider

Interface implemented by applications to access a valid JWT for the SDK using the connection to their own application server.

MessageId

typealias MessageId = String

MissingMandatoryParameter

data class MissingMandatoryParameter(val parameter: String, val location: String) : AxpSdkError

Error for the case where a response from the server is missing a value that is expected to be present.

MissingResponseBody

data object MissingResponseBody : AxpSdkError

Error for the case where a response from the server was expected to have a body, but there was no body.

NetworkError

data object NetworkError : AxpSdkError

Error for the case where an operation failed due to an error contacting AXP across the network.

NoSuchItemsExist

data object NoSuchItemsExist : AxpSdkError

Error for the case when there are no items to the variable you are accessing.

OrderBy

enum OrderBy : Enum<OrderBy>

Enumerated type for the order by options when fetching a list of items.

PageIterator

interface PageIterator<T>

Iterator which iterates over elements of type T in a paginated way. Elements are ordered in a most recent first manner i.e. each subsequent page will have older elements of type T.

Participant

interface Participant

Data about a participant in an AXP session.

ParticipantId

typealias ParticipantId = String

ParticipantsChangedListener